Update doc: Arduino as IDF component; fixes #5833 #6299
Conversation
pedrominatel
added
the
Type: Documentation
docs/source/esp-idf_component.rst
Outdated
| @@ -57,10 +84,10 @@ Option 1. Using Arduino setup() and loop() | |||
| Option 2. Using ESP-IDF appmain() | |||
| ********************************* | |||
|
|
|||
| - You need to implement ``app_main()`` and call ``initArduino();`` in it. | |||
| In main.c or main cpp you need to implement ``app_main()`` and call ``initArduino();`` in it. | |||
There was a problem hiding this comment.
missing . (period) between main and cpp.
There was a problem hiding this comment.
Thank you for catching this. I will commit fix later if there is nothing else to be fixed.
docs/source/esp-idf_component.rst
Outdated
|
|
||
| Arduino lib builder will allow you to build your own version of Arduino core for Arduino IDE. | ||
|
|
||
| To build your own Arduino core see `Arduino lib builder <https://github.com/espressif/esp32-arduino-lib-builder>`_ |
There was a problem hiding this comment.
It does not build the Arduino core. It builds ESP-IDF and collects all necessary headers, libraries and bootloaders. Basically everything inside tools/sdk.
There was a problem hiding this comment.
It is used when you need to have some specific ESP-IDF option that differs from what is already compiled in Arduino.
There was a problem hiding this comment.
What should the line be?
There was a problem hiding this comment.
Arduino Lib Builder is the tool that integrates ESP-IDF into Arduino. It allows you to customize the default settings used by Espressif and try them in Arduino IDE.
docs/source/esp-idf_component.rst
Outdated
|
|
||
| Build, flash and monitor | ||
| ************************ | ||
|
|
||
| - For both options use command ``idf.py -p <your-board-serial-port> flash monitor`` | ||
| - It will build, upload and open serial monitor to your board. | ||
|
|
||
| - The port is usually ``/dev/ttyUSB0`` search the active port with ``ls /dev/ttyUSB*`` |
There was a problem hiding this comment.
this is not true on Mac or Windows, Ports have very different names. It's maybe beyond this documentation to explain how one should find the serial port.
There was a problem hiding this comment.
Alright, I will remove this line in the next commit.
Summary
Updated documentation describing the usage of Arduino-esp32 core as ESP-IDF component.
Impact
Removed confusing mentions of advanced menuconfig options.
Extended process of installation, setup, and usage.
Related links
Closes #5833